Skip to main content

Shared nested objects

Item object:

FieldTypeRequiredNotes
itemIdstringNoItem id
itemNamestringNoItem name
itemUnitstringNoUnit name
itemQtyinteger (int32)NoQuantity * 1000, default 1000
itemAmountinteger (int64)NoLine amount
itemTaxesarray of tax objectsNoTax lines

Tax object:

FieldTypeRequiredNotes
taxCodestringNoSymbolic tax code
taxPrcinteger (int32)NoPercent * 100 (1800 = 18%)

Payment split object:

FieldTypeRequiredNotes
cashAmountinteger (int64)NoDefault 0
cashlessAmountinteger (int64)NoDefault 0
creditAmountinteger (int64)NoDefault 0
bonusesAmountinteger (int64)NoDefault 0
prepaymentAmountinteger (int64)NoDefault 0

Extra payment object:

FieldTypeRequiredNotes
codestringNoPayment code
amountinteger (int64)NoDefault 0
trxParamsobjectNoTransaction metadata

Extra payment transaction metadata object:

FieldTypeRequiredNotes
rrnstringNoTerminal reference number
cardNumberstringNoCard number (masked)
bankNamestringNoBank name

VAT entry object:

FieldTypeRequiredNotes
vatPercentinteger (int32)YesVAT rate percent * 100
vatAmountinteger (int64)YesVAT amount
currency_namestringNoCurrency